<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>PySpec Usage Guide</title>
<meta name="author" content="Shibukawa Yoshiki" />
<meta name="copyright" content="This document has been placed in the public domain." />
<style type="text/css">

/*
:Author: David Goodger
:Contact: goodger@users.sourceforge.net
:Date: $Date: 2005-12-18 01:56:14 +0100 (Sun, 18 Dec 2005) $
:Revision: $Revision: 4224 $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin-left: 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left {
  clear: left }

img.align-right {
  clear: right }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font-family: serif ;
  font-size: 100% }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em ;
  background-color: #eeeeee }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

tt.docutils {
  background-color: #eeeeee }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="pyspec-usage-guide">
<h1 class="title">PySpec Usage Guide</h1>
<table class="docinfo" frame="void" rules="none">
<col class="docinfo-name" />
<col class="docinfo-content" />
<tbody valign="top">
<tr><th class="docinfo-name">Author:</th>
<td>Shibukawa Yoshiki</td></tr>
<tr><th class="docinfo-name">Contact:</th>
<td>yoshiki at shibu.jp</td></tr>
<tr><th class="docinfo-name">Copyright:</th>
<td>This document has been placed in the public domain.</td></tr>
</tbody>
</table>
<div class="contents topic">
<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
<ul class="simple">
<li><a class="reference" href="#write-and-run-specs" id="id1" name="id1">Write and Run Specs</a><ul>
<li><a class="reference" href="#writing-specs" id="id2" name="id2">Writing Specs</a></li>
<li><a class="reference" href="#running-specs-on-console" id="id3" name="id3">Running Specs on Console</a></li>
<li><a class="reference" href="#running-specs-on-gui" id="id4" name="id4">Running Specs on GUI</a></li>
</ul>
</li>
<li><a class="reference" href="#spec-names" id="id5" name="id5">Spec Names</a><ul>
<li><a class="reference" href="#method-name" id="id6" name="id6">Method Name</a></li>
<li><a class="reference" href="#docstring" id="id7" name="id7">Docstring</a></li>
</ul>
</li>
</ul>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id1" id="write-and-run-specs" name="write-and-run-specs">Write and Run Specs</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id2" id="writing-specs" name="writing-specs">Writing Specs</a></h2>
<p>In PySpec, the specification is represented in python function or method.
These specification methods have special decorator.</p>
<p>example:</p>
<pre class="literal-block">
# This is function style spec

&#64;spec
def New_list_should_be_empty():
    About(list()).should_be_empty()

# This is method style spec
class List_Behavior(object):
  &#64;spec
  def New_list_should_be_empty():
      About(list()).should_be_empty()
</pre>
<p>If you want to share any objects between specifications and contexts
(context is a setup method), you should write specs in class. PySpec
creates one object per one spec. It doesn't pollute other test environment.</p>
<p>PySpec searches specs from top level functions and classes. If you write
specs in nested class, that will not be called.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id3" id="running-specs-on-console" name="running-specs-on-console">Running Specs on Console</a></h2>
<p>You have two ways to run console runner. First way is <tt class="docutils literal"><span class="pre">cuipyspec.py</span></tt> script.
Another is writing startup code into your spec source files. It's easy.</p>
<p>example:</p>
<pre class="literal-block">
from pyspec import *

# Define some specs here

if __name__ == &quot;__main__&quot;:
    run_test()
</pre>
<p>You don't have to register your specs. PySpec searches all modules that are
loaded in your interpreter automatically. So, this code can kick specs in
it.</p>
<p>If you want to run all specs that are divided into some files, creating
startup script is the easiest.</p>
<p>example:</p>
<pre class="literal-block">
from pyspec import*

import behavior_entities
import behavior_database_access
import behavior_views

run_test()
</pre>
<p>If you have created a spec startup script file and added startup code into all
your specs, you would be able to all tests and each test.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id4" id="running-specs-on-gui" name="running-specs-on-gui">Running Specs on GUI</a></h2>
<p>You can use GUI runner too. Run <tt class="docutils literal"><span class="pre">wxpyspec.py</span></tt> script. You can load spec module file
from <tt class="docutils literal"><span class="pre">[Project]</span> <span class="pre">-</span> <span class="pre">[Add</span> <span class="pre">module...]</span></tt> menu.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">notice:</th><td class="field-body">Now I rebuilding GUI runner. There are some bugs and not fixed.</td>
</tr>
</tbody>
</table>
<p>If you want to run GUI startup code from your spec script, please add
following code:</p>
<pre class="literal-block">
if __name__ == &quot;__main__&quot;:
    import pyspec.wxui.controller
    controller = pyspec.wxui.controller.WxPySpecController(0)
    controller.MainLoop()
</pre>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id5" id="spec-names" name="spec-names">Spec Names</a></h1>
<p>The spec which have good name is good spec. In pyspec, you have 2 ways to set the name.
These spec names will appear in the result report.</p>
<div class="section">
<h2><a class="toc-backref" href="#id6" id="method-name" name="method-name">Method Name</a></h2>
<p>Using method name is more simple way.</p>
<table border="1" class="docutils">
<colgroup>
<col width="53%" />
<col width="47%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Method Name</th>
<th class="head">Spec Name</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>A_stack_which_have_one_value()</td>
<td>A stack which have one value</td>
</tr>
<tr><td>version_info__in_sys_module()</td>
<td>version_info in sys module</td>
</tr>
<tr><td>one_of__test_method__should_fail()</td>
<td>one of test_method should fail</td>
</tr>
</tbody>
</table>
<p>This feature is implemented in pyspec.util.create_spec_name().</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id7" id="docstring" name="docstring">Docstring</a></h2>
<p>Docstring is used for the spec names. Python 2.X can accept ASCII names only as a method name.
This function is for programmers in Asia.</p>
<p>If you write docstring in context method and spec method, the first line of docstring
is used as a spec name.</p>
<p>PySpec gets docstring encoding from the first line of source code. If you want to use
Japanese or Chinese or any languages, you should write as following:</p>
<pre class="literal-block">
# -*- coding: utf8 -*-
</pre>
<p>Pyspec can accept any codec which is installed in python.</p>
<p>example:</p>
<pre class="literal-block">
class StackBehavior(object):
    &#64;context
    def A_stack_with_one_item(self):
        &quot;&quot;&quot;Youso wo hitotsu motsu stack.&quot;&quot;&quot;
        self.stack = Stack()
        self.stack.push(&quot;one item&quot;)

    &#64;spec
    def should_not_be_empty(self):
        &quot;&quot;&quot;kara dewa nai.&quot;&quot;&quot;
        About(self.stack).should_not_be_empty()
</pre>
<p>result:</p>
<pre class="literal-block">
Youso wo hitotsu motsu stack
    kara dewa nai ... OK
</pre>
<p>This sample docstrings are Japanese pronunciation in English.
Of course, you can write real Japanese.</p>
</div>
</div>
</div>
</body>
</html>
